EFFECTS STORE FOR SHOP 3
A phpBB extension by Thoul
Current Release: 1.3.0
Official Supported phpBB Release: 2.0.22
Official Supported Shop Release: 3.0.5 - 3.0.6

Table of Contents:
1) Introduction
2) Features
3) Release Notes
4) Included Files
5) Contact Information
6) Special Thanks

--------------------------------------------------------------------------------
                                  INTRODUCTION
--------------------------------------------------------------------------------

When Zarath released the 3.0.0 update of his popular Shop modification, he chose
not to include the special effects shop features.  These features, he said,
would later be released as a separate add-on for the base Shop.  Some other
add-ons were planned as well.  Six months later, when I at last got a chance to
begin working with Shop 3, those add-ons had not yet been released.  Life
happens to the best of us, and I'm sure Zarath was just too busy to finish them
up.

Since the special effects were the most requested add-on for Shop 3, I decided
to port the Shop 2 effects shop, to give more people reason to use the newest
Shop release.  After working with it for a few minutes, it became clear to me
that my personal coding style is so different from the Shop 2 code that it would
take a very, very long time to port.  The best way for me to continue was to
build a totally new effect shop from the ground up.  

This is Effects Store for Shop 3, a new take on the concept of a special
effects shop.  None of the original code from the Shop 2 effects shop is used in
this modification, but most of the original features have been duplicated.  Some
areas, mainly the admin panel, have been simplified bit.  A few new and improved
features are included, much of these in the public shop.

--------------------------------------------------------------------------------
                                    FEATURES
--------------------------------------------------------------------------------

-Allows members to spend points to buy various special effects and privileges.
 Supported privileges include:
	-Use of Avatars
	-Use of Signatures
	-Custom Title (in addition to normal rank)
	-Custom Title may replace rank title
	-Change username
	-Change Custom Title of other members
		-Hover your mouse over a title to see who used this privilege.
 Supported effects include:
	-Username color, glow, and shadow
	-Rank/Custom Title color, glow, and shadow
-Color selections may be made using a color picker ported from phpBB 3.
-Instant preview of color selections when using the color picker.
-Manual color preview without reloading the page.
-For members that have not bought the privileges, signature and avatar fields
 are hidden in profile editing.
-Admins and moderators can use signatures, avatars, and username change without
 purchase (can be turned off).
-All effects can be enabled or disabled easily: just enter or remove a price in
	the Admin Panel!
-Word censors are applied to all custom titles.
-When using Cash mod, the currency for purchases can be configured to any
 enabled currency.
-Built-in support for Shop 3 Admin Navigation and Censor Block.

Please see contrib/known_issues.txt for a list of known issues.

--------------------------------------------------------------------------------
                                 RELEASE NOTES
--------------------------------------------------------------------------------

Version 1.3.0 - April 13, 2007
SilverKnight discovered some problems with the Change Custom Title of other
members feature, allowing for negative cash values and title changing when it
could not be afforded.  This has been fixed, along with some caching issues in user profiles.

Recently, Zarath released Shop 3.1.0 Beta.  Effects Store is not officially compatible with the new Beta, mainly due to changes in the admin panel.
However, I have added contrib/shop310_acp/ for those that would like to try
Effects Store with the new Beta.  You'll find instructions for installing an
admin panel add-on for Effects Configuration there. Read the warnings in the install.txt found there before using this add-on!

This is the last version of Effects Store that will support the Shop 3.0.x line.
The next release, Effects Store 2.0.0, will be a major rewrite geared toward the
new Shop 3.1.x line.

--------------------------------------------------------------------------------
                                 INCLUDED FILES
--------------------------------------------------------------------------------

When the ZIP file for this download is unpacked, the following new directories
may be created on your system, each containing the noted files.
	contrib   - Important documents regarding usage of the download. READ THEM.
	root      - New files that will be added to your forum, if any.
	premodded - Original phpBB files, with this download already installed.
The "root" and "premodded" directories may not be present - this usually means
they are either not needed or included for this modification.
Alongside these directories, you should see a install.txt file.  This has the
install instructions.

The "contrib" directory may contain the following files:
	license.txt       - License information regarding this download.
	release_notes.txt - Short summary of changes in each version.
	changelog.txt     - Detailed list of changes to each version.
	upgrade*.txt      - Instructions for upgrading from a previous version.
	uninstall.txt     - Instructions for uninstalling.
The "contrib" directory may also contain a file with the extension .hl, such as
"contact.hl."  This is a file for use with Nivisec's Mods/Hack List
modification.  If you don't have that modification installed, ignore this file.
If you do have it installed, then check it includes documentation for this file.

--------------------------------------------------------------------------------
                              CONTACT INFORMATION
--------------------------------------------------------------------------------

To find other phpBB material I have created, please visit these web sites:
phpBB Smith            http://www.phpbbsmith.com/
phpBB.com              http://www.phpbb.com/
phpBBHacks.com         http://www.phpbbhacks.com/
                       http://www.phpbbhacks.com/searchresults.php?author=Thoul

phpBB Smith is my personal phpBB related web site and therefore tends to have
most of my works (including older versions if needed), while the other sites
generally have some, but not all, of my stuff around somewhere.  Basically, they
all have different things, so check them all.  If you need to e-mail me, I can
be reached via a contact form at the phpBB Smith site.

Have a nice day. :D

--------------------------------------------------------------------------------
                                 SPECIAL THANKS
--------------------------------------------------------------------------------

I would like to extend a special "Thank You" to the following:
Zarath, for making the Shop mod
Bug Finders in Effects Store 1.x:
	-brevcom
	-ladyphoenix
	-neonshadow
	-nickwp
	-Pogue Morgan
	-Teejay Garcia
	-SilverKnight